API Request Log
[Log] > [API Request Log]
⚠️ This feature is through a patch**[Policy] > [Integration System Policy]It has been integrated into the menu.
You can manage the integration system registration, API Key issuance, and policy settings all in one place.
API request log is[Log] > [API Request Log]**You can check it at.
The API access control feature of the SHIELDEX File allows setting access permissions by administrator for each integrated system, and supports checking and managing API call history.
Administrators can refine API access permissions based on the integration system, issue API Keys for each permission, or view request logs.
⚠️ 'API Access Control' setting permission is granted to [Administrator Type - Super Administrator], and
Administrator permission settings can be done in [Administrator] > [Administrator List].
▷ Integration System Registration
Register the integration system that serves as the basis for API access control.
Add Integration System
+ 연동 시스템 추가Enter the following items when the button is clicked.
| item | Explanation |
|---|---|
| Integration System Name | Unique Identifier Name (e.g., FRD, OPS, etc.) |
| label | Description or name of the integration system |
When deleting the integration system, all related access settings and logs will be deleted and cannot be recovered.
Removal Guide
- You cannot delete it if there are related access control settings.
- Once deletion is confirmed, all associated data will be deleted along with it and cannot be recovered.
▷ Access Control Settings
Specify the administrator who will grant API access permissions for the registered integration system, and issue and manage the API Key.
Access Control Registration
+ 접근 제어 등록Set the following items when the button is clicked.
| item | Explanation |
|---|---|
| Integration System | Selectable Registered Integration Systems |
| Responsible Integration System Administrator | Admin account granted API access permission |
- Once the registration is complete, the API Key will be automatically generated and displayed in the list.
Display Item
| item | Explanation |
|---|---|
| Registration Time | Time when access permissions are set |
| Integration System | Access Control Target Integration System |
| Administrator ID | Administrator account with access rights |
| API Key | Key used for authentication (caution for external exposure) |
| Action | Provide a button to disable access control |
Change Administrator
담당 관리자 변경You can change the administrator with access rights by clicking the button.
Access Control Release
해제Clicking the button will delete the corresponding API Key and access policy.
▷ Access Control Log
You can view the request history made through the API. Each request record is provided with detailed information and supports filtering and export features.
Log Items
| item | Explanation |
|---|---|
| API | Request Type (Inquiry, Download, etc.) |
| Customer Number / User Management Number | Requesting Entity Identifier |
| Integration System Name / Label | Request Classification Information |
| Request Task ID | Unique ID to track the request |
| File Relative Path | Result file save path |
| file name | Processed file name |
| Request Time / IP | Request Occurrence Time and Client IP |
| Response Message | Processing result in JSON format |
| Response Code | HTTP status codes (e.g., 200, 403, etc.) |
Filter Function
- You can specify a date range to query logs for a specific period.
- You can check logs categorized by request type filters (All, Application, Inquiry, Download, Allow, Block, etc.).
- You can filter by various conditions such as customer number, user number, integration system name, label, file name, etc.
Export Function
- Top left
내보내기When you click the button, the logs that match the current query conditions will beDownload as CSV fileYou can do it.
CSV files can be used for purposes such as storing audit logs, generating reports, and tracking system integration errors.
Reference Note
- We systematically separate API access permissions within the organization using the integration system.
- Manage the API Key to ensure it is not exposed externally, and if necessary, revoke it immediately and re-register.
- API access logs are periodically backed up or stored through the export feature.